Run(RasterImage,PageRequestCallback,object,List<IMasterFormsCategory>) Method

Summary

Automatically recognizes the unknown form then it processes its fields.

Syntax

C++

Java

public AutoFormsRunResult Run( 
   RasterImage form, 
   PageRequestCallback pageRequestCallback, 
   object userData, 
   List<IMasterFormsCategory> categories 
)

  
Public Overloads Function Run( _ 
   ByVal form As RasterImage, _ 
   ByVal pageRequestCallback As PageRequestCallback, _ 
   ByVal userData As Object, _ 
   ByVal categories As List(Of IMasterFormsCategory) _ 
) As AutoFormsRunResult

public AutoFormsRunResult run( 
   RasterImage,  
   PageRequestCallback,  
   java.lang.Object,  
   java.util.List<IMasterFormsCategory> 
);

public: 
AutoFormsRunResult^ Run(  
   RasterImage^ form, 
   PageRequestCallback^ pageRequestCallback, 
   Object^ userData, 
   List<IMasterFormsCategory^>^ categories 
)

Parameters

form
The unknown form image.

pageRequestCallback
Page request callback if more form images are needed.

userData
The user defined data that is associated with PageRequestCallback.

categories
List of Master Forms categories to use in comparison, pass null or empty to use all Master Forms in the repository.

Return Value

Returns the results of the recognition and processing if the form is recognized, otherwise it returns null. If the Master Form has no processing field, AutoFormsRunResult.FormFields will be null.

Remarks

This method automatically recognizes the unknown form and process its fields at the same time.

If RecognizeFirstPageOnly is true, the recognition will be performed based on the first page only, if it is false the recognition will be performed over all the form pages.

When RecognizeFirstPageOnly is true and the recognition is performed based on the first page only, form should have at least the first page of the form. So during processing, when more pages are required this method will ask for the required pages one page at a time using the pageRequestCallback. The PageRequestCallbackData.FormPageNumber will have the number of the required page and the user returns the requested page image through the PageRequestCallbackData.Page. For example, in the case where multiple forms are fed to the scanner, you scan the first page and pass it to the form, recognize its form by doing the comparison based on the first page, and then after the form is recognized, the engine will ask for the required pages which you then have to scan for further processing.

If the form is not recognized it will return null. If the Master Form of the form type has no field then AutoFormsRunResult.FormFields will be null.

If form has all form pages you can set pageRequestCallback to null.

Example

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Forms.Common; 
using Leadtools.Forms.Auto; 
using Leadtools.Ocr; 
using Leadtools.Forms.Recognition; 
using Leadtools.Forms.Processing; 
using Leadtools.Barcode; 
 
 
public RasterCodecs Codecs; 
public string FormFileName; 
 
public void MyPageRequestCallback(PageRequestCallbackData data) 
{ 
   data.Page = Codecs.Load(FormFileName, 1, CodecsLoadByteOrder.Bgr, data.FormPageNumber, data.FormPageNumber); 
} 
public void AutoFormRunAutomatic() 
{ 
   string root = Path.Combine(LEAD_VARS.ImagesDir, @"Forms\FormsDemo\OCR_Test"); 
   RasterCodecs codecs = new RasterCodecs(); 
   //create repository 
   DiskMasterFormsRepository repository = new DiskMasterFormsRepository(codecs, root); 
 
   using (IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD)) 
   { 
      ocrEngine.Startup(null, null, null, LEAD_VARS.OcrLEADRuntimeDir); 
      BarcodeEngine barcodeEngine = new BarcodeEngine(); 
 
      //create AutoForm Engine 
      AutoFormsEngine autoEngine = new AutoFormsEngine(repository, ocrEngine, barcodeEngine); 
      //set the flag to process the first page only 
      autoEngine.RecognizeFirstPageOnly = true; 
      autoEngine.MinimumConfidenceKnownForm = 40; 
      //calculate the minimum confidence recognized form according to the correlation between the master forms in the repository 
      autoEngine.MinimumConfidenceRecognized = autoEngine.GetMinimumRecognizedConfidenceForm(); 
 
      Codecs = codecs; 
      FormFileName = Path.Combine(LEAD_VARS.ImagesDir, @"Forms\Forms to be Recognized\OCR\FCC-107_OCR_Filled.tif"); 
      //load the first page of the image 
      RasterImage form = codecs.Load(FormFileName, 1, CodecsLoadByteOrder.Bgr, 1, 1); 
      //recognize and process the form 
      AutoFormsRunResult result = autoEngine.Run(form, MyPageRequestCallback, null, null); 
      if (result == null) 
         return; 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\LEADTOOLS21\Resources\Images"; 
   public const string OcrLEADRuntimeDir = @"C:\LEADTOOLS21\Bin\Common\OcrLEADRuntime"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Forms.Common 
Imports Leadtools.Forms.Auto 
Imports Leadtools.Ocr 
Imports Leadtools.Forms.Recognition 
Imports Leadtools.Forms.Processing 
Imports Leadtools.Barcode 
 
Public Codecs As RasterCodecs 
Public FormFileName As String 
 
Public Sub MyPageRequestCallback(ByVal data As PageRequestCallbackData) 
   data.Page = Codecs.Load(FormFileName, 1, CodecsLoadByteOrder.Bgr, data.FormPageNumber, data.FormPageNumber) 
End Sub 
 
Public Sub AutoFormRunAutomatic() 
 
   Dim root As String = Path.Combine(LEAD_VARS.ImagesDir, "Forms\FormsDemo\OCR_Test") 
 
   Dim codecs_Renamed As RasterCodecs = New RasterCodecs() 
   'create repository 
   Dim repository As DiskMasterFormsRepository = New DiskMasterFormsRepository(codecs_Renamed, root) 
 
   Using ocrEngine As IOcrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD) 
      ocrEngine.Startup(Nothing, Nothing, Nothing, LEAD_VARS.OcrLEADRuntimeDir) 
      Dim engineBarcode As BarcodeEngine = New BarcodeEngine() 
 
      'create AutoForm Engine 
      Dim autoEngine As AutoFormsEngine = New AutoFormsEngine(repository, ocrEngine, engineBarcode) 
      'set the flag to process the first page only 
      autoEngine.RecognizeFirstPageOnly = True 
      autoEngine.MinimumConfidenceKnownForm = 40 
      'calculate the minimum confidence recognized form according to the correlation between the master forms in the repository 
      autoEngine.MinimumConfidenceRecognized = autoEngine.GetMinimumRecognizedConfidenceForm() 
 
      Codecs = codecs_Renamed 
      FormFileName = Path.Combine(LEAD_VARS.ImagesDir, "Forms\Images\FCC-107_OCR_Filled.tif") 
      'load the first page of the image 
      Dim form As RasterImage = codecs_Renamed.Load(FormFileName, 1, CodecsLoadByteOrder.Bgr, 1, 1) 
      'recognize and process the form 
      Dim result As AutoFormsRunResult = autoEngine.Run(form, AddressOf MyPageRequestCallback, Nothing, Nothing) 
      If result Is Nothing Then 
         Return 
      End If 
   End Using 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\LEADTOOLS21\Resources\Images" 
   Public Const OcrLEADRuntimeDir As String = "C:\LEADTOOLS21\Bin\Common\OcrLEADRuntime" 
End Class

Requirements

Target Platforms

Reference

AutoFormsEngine Class

AutoFormsEngine Members

Overload List

Download our FREE evaluation

Help Version 21.0.2021.6.30

Leadtools.Forms.Auto Assembly

Introduction

Getting Started

Namespaces

Leadtools.Forms.Auto Namespace

Assemblies